package br.com.it4.zmed.service;

import java.util.List;

import br.com.it4.framework.util.exception.BusinessException;
import br.com.it4.framework.util.exception.SystemException;
import br.com.it4.zmed.entity.Exame;
import br.com.it4.zmed.filter.ExameFilter;

/**
 * Interface de acesso as funcionalidades de exame.
 * 
 * @author Mozart Silva (mozart.vsilva@gmail.com)
 * 
 */
public interface ExameService {

    /**
     * Adiciona um determinado exame.
     * 
     * @param exame
     *            O exame a ser adicionado.
     * @return O exame adicionado.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     * @throws BusinessException
     *             Exceção caso ocorra erro na validação.
     */
    public Exame addExame(Exame exame) throws SystemException, BusinessException;

    /**
     * Atualiza um determinado exame.
     * 
     * @param exame
     *            O exame a ser atualizado.
     * @return O exame atualizado.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     * @throws BusinessException
     *             Exceção caso ocorra erro na validação.
     */
    public Exame updateExame(Exame exame) throws SystemException, BusinessException;

    /**
     * Remove um determinado exame.
     * 
     * @param exame
     *            O perfil a ser removido.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public void removeExame(Exame exame) throws SystemException;

    /**
     * Consulta um determinado exame a partir da entidade.
     * 
     * @param codigo
     *            O codigo do exame a ser consultado.
     * @return A lista de exames.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public Exame getExame(String codigo) throws SystemException;

    /**
     * Consulta a lista de exames.
     * 
     * @return A lista de exames.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public List<Exame> getExames() throws SystemException;

    /**
     * Consulta um determinado número de exames a partir do filtro.
     * 
     * @param filtro
     *            Filtro para o exame.
     * @param registroInicio
     *            O registro de inicio retornado.
     * @param registroFim
     *            O registro final retornado.
     * @return A lista de exames.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public List<Exame> getExames(ExameFilter filtro, int registroInicio, int registroFim)
            throws SystemException;

    /**
     * Calcula o número de registros de exames a partir pelo filtro.
     * 
     * @param filtro
     *            Filtro para o exame.
     * @return O número de registros encontrados.
     * @throws SystemException
     *             Caso ocorra algum erro na execução.
     */
    public Long getExamesCount(ExameFilter filtro) throws SystemException;

}